<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>yuidoc - YUIDoc</title>
    <link rel="stylesheet" href="https://yui-s.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css">
    <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css">
    <link rel="stylesheet" href="../assets/css/main.css" id="site_styles">
    <link rel="icon" href="../assets/favicon.ico">
    <script src="https://yui-s.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script>
</head>
<body class="yui3-skin-sam">

<div id="doc">
    <div id="hd" class="yui3-g header">
        <div class="yui3-u-3-4">
                <h1><img src="../assets/css/logo.png" title="YUIDoc" width="117" height="52"></h1>
        </div>
        <div class="yui3-u-1-4 version">
            <em>API Docs for: 0.10.0</em>
        </div>
    </div>
    <div id="bd" class="yui3-g">

        <div class="yui3-u-1-4">
            <div id="docs-sidebar" class="sidebar apidocs">
                <div id="api-list">
                    <h2 class="off-left">APIs</h2>
                    <div id="api-tabview" class="tabview">
                        <ul class="tabs">
                            <li><a href="#api-classes">Classes</a></li>
                            <li><a href="#api-modules">Modules</a></li>
                        </ul>
                
                        <div id="api-tabview-filter">
                            <input type="search" id="api-filter" placeholder="Type to filter APIs">
                        </div>
                
                        <div id="api-tabview-panel">
                            <ul id="api-classes" class="apis classes">
                                <li><a href="../classes/CLI.html">CLI</a></li>
                                <li><a href="../classes/DocBuilder.html">DocBuilder</a></li>
                                <li><a href="../classes/DocParser.html">DocParser</a></li>
                                <li><a href="../classes/DocView.html">DocView</a></li>
                                <li><a href="../classes/Files.html">Files</a></li>
                                <li><a href="../classes/Help.html">Help</a></li>
                                <li><a href="../classes/Main.html">Main</a></li>
                                <li><a href="../classes/Options.html">Options</a></li>
                                <li><a href="../classes/Server.html">Server</a></li>
                                <li><a href="../classes/Utils.html">Utils</a></li>
                                <li><a href="../classes/YUIDoc.html">YUIDoc</a></li>
                            </ul>
                
                
                            <ul id="api-modules" class="apis modules">
                                <li><a href="../modules/yuidoc.html">yuidoc</a></li>
                            </ul>
                        </div>
                    </div>
                </div>
            </div>
        </div>
        <div class="yui3-u-3-4">
                <div id="api-options">
                    Show:
                    <label for="api-show-inherited">
                        <input type="checkbox" id="api-show-inherited" checked>
                        Inherited
                    </label>
            
                    <label for="api-show-protected">
                        <input type="checkbox" id="api-show-protected">
                        Protected
                    </label>
            
                    <label for="api-show-private">
                        <input type="checkbox" id="api-show-private">
                        Private
                    </label>
                    <label for="api-show-deprecated">
                        <input type="checkbox" id="api-show-deprecated">
                        Deprecated
                    </label>
            
                </div>
            
            <div class="apidocs">
                <div id="docs-main">
                    <div class="content">
<h1>yuidoc Module</h1>
<div class="box clearfix meta">


        <div class="foundat">
            Defined in: <a href="../files/lib_yuidoc.js.html#l51"><code>lib&#x2F;yuidoc.js:51</code></a>
        </div>

</div>


<div class="box intro">
    <p>This is the <strong>module</strong> description for the <code>YUIDoc</code> module.</p>
<pre class="code prettyprint"><code>var options = {
    paths: [ './lib' ],
    outdir: './out'
};

var Y = require('yuidocjs');
var json = (new Y.YUIDoc(options)).run();</code></pre>

</div>


<div class="yui3-g">
    <div class="yui3-u-1-2">
            <p>This module provides the following classes:</p>

            <ul class="module-classes">
                <li class="module-class">
                    <a href="../classes/CLI.html">
                        CLI
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/DocBuilder.html">
                        DocBuilder
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/DocParser.html">
                        DocParser
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/DocView.html">
                        DocView
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/Files.html">
                        Files
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/Help.html">
                        Help
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/Main.html">
                        Main
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/Options.html">
                        Options
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/Server.html">
                        Server
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/Utils.html">
                        Utils
                    </a>
                </li>
                <li class="module-class">
                    <a href="../classes/YUIDoc.html">
                        YUIDoc
                    </a>
                </li>
            </ul>
    </div>


    <div class="yui3-u-1-2">
    </div>
</div>
                    </div>
                </div>
            </div>
        </div>
    </div>
</div>
<script src="../assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="../assets/js/yui-prettify.js"></script>
<script src="../assets/../api.js"></script>
<script src="../assets/js/api-filter.js"></script>
<script src="../assets/js/api-list.js"></script>
<script src="../assets/js/api-search.js"></script>
<script src="../assets/js/apidocs.js"></script>
</body>
</html>
